feat: add ability to export features for static node #2183

vsoch · 2025-06-25T15:49:02Z

Problem: We want to statically export NFD features for HPC.
Solution: Add an nfd export features mode that allows for generation and export of static feature labels.

For the HPC use case, we want to be able to export static features, either to the screen (for inspection) or a file (for saving and use with a scheduler, or other compatibility checking algorithm). Adding support for this is fairly easy - we need to just add the subcommand. The usage is simple and intuitive:

# Export raw features to the terminal for inspection
nfd export features

# Save to a file path
nfd export features --path features.json

# or the same for labels
nfd export labels
nfd export labels --path labels.json

The flag is also useful for cases beyond HPC when a quick inspection is desired. There are ways this could be extended (requesting specific groups or filters) but I think it's better to start simple.

This is a follow up of #2170. If you'd like tests added, I did an attempt and it looks like the features aren't exposed in the test environment - we would need a mock. Please point me to an example for how to do that. Thanks!

k8s-ci-robot · 2025-06-25T15:49:12Z

Hi @vsoch. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

netlify · 2025-06-25T15:49:17Z

✅ Deploy Preview for kubernetes-sigs-nfd ready!

Name	Link
🔨 Latest commit	`0323fdf`
🔍 Latest deploy log	https://app.netlify.com/projects/kubernetes-sigs-nfd/deploys/688a535f5d47ab00085a103e
😎 Deploy Preview	https://deploy-preview-2183--kubernetes-sigs-nfd.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

cmd/nfd/subcmd/export/features.go

mfranczy · 2025-06-30T11:23:20Z

That's a nice functionality, not only for non-k8s use cases, but also for taking a snapshot of the node's state from the perspective of enabled features.

cmd/nfd/subcmd/export/export.go

ChaoyiHuang · 2025-07-02T01:04:16Z

cmd/nfd/subcmd/export/export.go

+
+var ExportCmd = &cobra.Command{
+	Use:   "export",
+	Short: "Export features commands",


Export features or labels commands

Good catch! What do you think of just "Export commands" to be generic for the export group? 🤔

of course much more friendly for extention :)

mfranczy

lgtm

/cc @marquiz @ArangoGutierrez

cmd/nfd/subcmd/export/labels.go

cmd/nfd/subcmd/export/features.go

ChaoyiHuang · 2025-07-18T00:57:20Z

/lgtm

vsoch · 2025-07-23T23:52:50Z

Ping @adrianchiris @zvonkok @ArangoGutierrez @marquiz we've gone through several rounds of review and have LGTM from the compatibility working group. Can any of you review this?

ArangoGutierrez · 2025-07-24T09:34:00Z

/ok-to-test

cmd/nfd/subcmd/export/export.go

cmd/nfd/subcmd/export/utils.go

ArangoGutierrez · 2025-07-24T09:45:44Z

cmd/nfd/subcmd/export/utils.go

+)
+
+var (
+	outputPath string


If Var is global for the pkg export, why have it as an entry value for writeToFile?

It is global (and private) because it's a shared flag, and I usually see those defined in this way. For the latter, I think it's better practice to not have package functions rely on global variables.

cmd/nfd/subcmd/export/utils.go

fmuyassarov · 2025-07-30T12:33:12Z

docs/usage/nfd-export.md

+
+### Features
+
+**Feature export is in the experimental `v1alpha1` version.**


Is it OK to refer to this as v1alpha1 even if isn't an API but a command line option?

We could just say it is an experimental version. Would that be better?

probably would be better, not to give a wrong impression to the readers.

Will do! I’m running to the bakery to be there when it opens but will change this when I get back. Thanks for the review!

For the HPC use case, we want to be able to export static features, raw or as labels, to the terminal or a JSON path. Signed-off-by: vsoch <[email protected]>

fmuyassarov

Thank you. LGTM

fmuyassarov · 2025-07-30T19:55:25Z

/test pull-node-feature-discovery-build-image-cross-generic

ArangoGutierrez

PING @marquiz for lgtm

k8s-ci-robot · 2025-08-04T15:44:11Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ArangoGutierrez, mfranczy, vsoch

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [ArangoGutierrez]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 25, 2025

k8s-ci-robot requested review from adrianchiris and zvonkok June 25, 2025 15:49

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 25, 2025

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 25, 2025

vsoch mentioned this pull request Jun 25, 2025

feat: add ability to export feature labels for static node #2170

Closed

ChaoyiHuang reviewed Jun 28, 2025

View reviewed changes

cmd/nfd/subcmd/export/features.go Outdated Show resolved Hide resolved

ChaoyiHuang reviewed Jun 28, 2025

View reviewed changes

cmd/nfd/subcmd/export/features.go Outdated Show resolved Hide resolved

vsoch force-pushed the add-cli-export branch from ef37aaf to 34bc1d0 Compare June 28, 2025 05:03

mfranczy reviewed Jun 30, 2025

View reviewed changes

cmd/nfd/subcmd/export/features.go Outdated Show resolved Hide resolved

cmd/nfd/subcmd/export/features.go Outdated Show resolved Hide resolved

vsoch force-pushed the add-cli-export branch from 34bc1d0 to 6cb8333 Compare June 30, 2025 12:19

mfranczy reviewed Jul 1, 2025

View reviewed changes

cmd/nfd/subcmd/export/export.go Outdated Show resolved Hide resolved

vsoch force-pushed the add-cli-export branch from fa2eb19 to 131ad16 Compare July 1, 2025 23:45

ChaoyiHuang reviewed Jul 2, 2025

View reviewed changes

vsoch force-pushed the add-cli-export branch from 131ad16 to 341bdb6 Compare July 2, 2025 02:32

mfranczy approved these changes Jul 2, 2025

View reviewed changes

k8s-ci-robot requested review from ArangoGutierrez and marquiz July 2, 2025 06:30

ChaoyiHuang reviewed Jul 14, 2025

View reviewed changes

cmd/nfd/subcmd/export/labels.go Show resolved Hide resolved

vsoch force-pushed the add-cli-export branch 2 times, most recently from 5cf1950 to 4a3fa78 Compare July 14, 2025 04:30

ChaoyiHuang reviewed Jul 17, 2025

View reviewed changes

cmd/nfd/subcmd/export/features.go Outdated Show resolved Hide resolved

vsoch force-pushed the add-cli-export branch from 4a3fa78 to 6e55dce Compare July 17, 2025 17:14

k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Jul 24, 2025

k8s-ci-robot removed the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 24, 2025

ArangoGutierrez self-assigned this Jul 24, 2025

ArangoGutierrez requested changes Jul 24, 2025

View reviewed changes

vsoch force-pushed the add-cli-export branch 4 times, most recently from 43fd3b0 to 97d9001 Compare July 24, 2025 16:41

vsoch requested a review from ArangoGutierrez July 24, 2025 16:45

ChaoyiHuang reviewed Jul 25, 2025

View reviewed changes

cmd/nfd/subcmd/export/utils.go Outdated Show resolved Hide resolved

vsoch force-pushed the add-cli-export branch from 97d9001 to f72f76f Compare July 25, 2025 06:12

fmuyassarov reviewed Jul 30, 2025

View reviewed changes

feat: add ability to export

0323fdf

For the HPC use case, we want to be able to export static features, raw or as labels, to the terminal or a JSON path. Signed-off-by: vsoch <[email protected]>

vsoch force-pushed the add-cli-export branch from f72f76f to 0323fdf Compare July 30, 2025 17:16

fmuyassarov reviewed Jul 30, 2025

View reviewed changes

ArangoGutierrez approved these changes Aug 4, 2025

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 4, 2025


		### Features

		Feature export is in the experimental `v1alpha1` version.

feat: add ability to export features for static node #2183

Are you sure you want to change the base?

feat: add ability to export features for static node #2183

Conversation

vsoch commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Jun 25, 2025

Uh oh!

netlify bot commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for kubernetes-sigs-nfd ready!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mfranczy commented Jun 30, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mfranczy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ChaoyiHuang commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vsoch commented Jul 23, 2025

Uh oh!

ArangoGutierrez commented Jul 24, 2025

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fmuyassarov left a comment

Choose a reason for hiding this comment

Uh oh!

fmuyassarov commented Jul 30, 2025

Uh oh!

ArangoGutierrez left a comment

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Aug 4, 2025

Uh oh!

Uh oh!

vsoch commented Jun 25, 2025 •

edited

Loading

netlify bot commented Jun 25, 2025 •

edited

Loading

ChaoyiHuang commented Jul 18, 2025 •

edited

Loading